<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.10">
<meta name="author" content="Dan Allen">
<title>什么是 AsciiDoc? 我们为什么需要它?</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<style>
/* Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
/* Uncomment @import statement to use as custom stylesheet */
/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}
audio,video{display:inline-block}
audio:not([controls]){display:none;height:0}
html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
a{background:none}
a:focus{outline:thin dotted}
a:active,a:hover{outline:0}
h1{font-size:2em;margin:.67em 0}
abbr[title]{border-bottom:1px dotted}
b,strong{font-weight:bold}
dfn{font-style:italic}
hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
mark{background:#ff0;color:#000}
code,kbd,pre,samp{font-family:monospace;font-size:1em}
pre{white-space:pre-wrap}
q{quotes:"\201C" "\201D" "\2018" "\2019"}
small{font-size:80%}
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
sup{top:-.5em}
sub{bottom:-.25em}
img{border:0}
svg:not(:root){overflow:hidden}
figure{margin:0}
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
legend{border:0;padding:0}
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
button,input{line-height:normal}
button,select{text-transform:none}
button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
button[disabled],html input[disabled]{cursor:default}
input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
textarea{overflow:auto;vertical-align:top}
table{border-collapse:collapse;border-spacing:0}
*,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
html,body{font-size:100%}
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
a:hover{cursor:pointer}
img,object,embed{max-width:100%;height:auto}
object,embed{height:100%}
img{-ms-interpolation-mode:bicubic}
.left{float:left!important}
.right{float:right!important}
.text-left{text-align:left!important}
.text-right{text-align:right!important}
.text-center{text-align:center!important}
.text-justify{text-align:justify!important}
.hide{display:none}
img,object,svg{display:inline-block;vertical-align:middle}
textarea{height:auto;min-height:50px}
select{width:100%}
.center{margin-left:auto;margin-right:auto}
.stretch{width:100%}
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
a{color:#2156a5;text-decoration:underline;line-height:inherit}
a:hover,a:focus{color:#1d4b8f}
a img{border:0}
p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
p aside{font-size:.875em;line-height:1.35;font-style:italic}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
h1{font-size:2.125em}
h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h4,h5{font-size:1.125em}
h6{font-size:1em}
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
em,i{font-style:italic;line-height:inherit}
strong,b{font-weight:bold;line-height:inherit}
small{font-size:60%;line-height:inherit}
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol{margin-left:1.5em}
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
ul.square{list-style-type:square}
ul.circle{list-style-type:circle}
ul.disc{list-style-type:disc}
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
dl dt{margin-bottom:.3125em;font-weight:bold}
dl dd{margin-bottom:1.25em}
abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
abbr{text-transform:none}
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
blockquote cite::before{content:"\2014 \0020"}
blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
h1{font-size:2.75em}
h2{font-size:2.3125em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
h4{font-size:1.4375em}}
table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
table thead,table tfoot{background:#f7f8f7}
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
table tr.even,table tr.alt{background:#f8f8f7}
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
.clearfix::after,.float-group::after{clear:both}
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
:not(pre)>code.nobreak{word-wrap:normal}
:not(pre)>code.nowrap{white-space:nowrap}
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
pre>code{display:block}
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
em em{font-style:normal}
strong strong{font-weight:400}
.keyseq{color:rgba(51,51,51,.8)}
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
.keyseq kbd:first-child{margin-left:0}
.keyseq kbd:last-child{margin-right:0}
.menuseq,.menuref{color:#000}
.menuseq b:not(.caret),.menuref{font-weight:inherit}
.menuseq{word-spacing:-.02em}
.menuseq b.caret{font-size:1.25em;line-height:.8}
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
b.button::before{content:"[";padding:0 3px 0 2px}
b.button::after{content:"]";padding:0 2px 0 3px}
p a>code:hover{color:rgba(0,0,0,.9)}
#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
#content{margin-top:1.25em}
#content::before{content:none}
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
#header .details span:first-child{margin-left:-.125em}
#header .details span.email a{color:rgba(0,0,0,.85)}
#header .details br{display:none}
#header .details br+span::before{content:"\00a0\2013\00a0"}
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
#header #revnumber{text-transform:capitalize}
#header #revnumber::after{content:"\00a0"}
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
#toc>ul{margin-left:.125em}
#toc ul.sectlevel0>li>a{font-style:italic}
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
#toc li{line-height:1.3334;margin-top:.3334em}
#toc a{text-decoration:none}
#toc a:active{text-decoration:underline}
#toctitle{color:#7a2518;font-size:1.2em}
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
body.toc2{padding-left:15em;padding-right:0}
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
body.toc2.toc-right{padding-left:0;padding-right:15em}
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
#toc.toc2{width:20em}
#toc.toc2 #toctitle{font-size:1.375em}
#toc.toc2>ul{font-size:.95em}
#toc.toc2 ul ul{padding-left:1.25em}
body.toc2.toc-right{padding-left:0;padding-right:20em}}
#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
#content #toc>:first-child{margin-top:0}
#content #toc>:last-child{margin-bottom:0}
#footer{max-width:100%;background:rgba(0,0,0,.8);padding:1.25em}
#footer-text{color:rgba(255,255,255,.8);line-height:1.44}
#content{margin-bottom:.625em}
.sect1{padding-bottom:.625em}
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
.sect1{padding-bottom:1.25em}}
.sect1:last-child{padding-bottom:0}
.sect1+.sect1{border-top:1px solid #e7e7e9}
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
details>summary:first-of-type{cursor:pointer;display:list-item;outline:none;margin-bottom:.75em}
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
.paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit}
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
.admonitionblock>table td.icon{text-align:center;width:80px}
.admonitionblock>table td.icon img{max-width:none}
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6)}
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
.exampleblock>.content>:first-child{margin-top:0}
.exampleblock>.content>:last-child{margin-bottom:0}
.sidebarblock{border-style:solid;border-width:1px;border-color:#dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;-webkit-border-radius:4px;border-radius:4px}
.sidebarblock>:first-child{margin-top:0}
.sidebarblock>:last-child{margin-bottom:0}
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
.literalblock pre,.listingblock>.content>pre{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;overflow-x:auto;padding:1em;font-size:.8125em}
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class="highlight"],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
.listingblock>.content{position:relative}
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
.listingblock:hover code[data-lang]::before{display:block}
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
.listingblock pre.highlightjs{padding:0}
.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
.listingblock pre.prettyprint{border-width:0}
.prettyprint{background:#f7f7f8}
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
pre.prettyprint li code[data-lang]::before{opacity:1}
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
table.linenotable td.code{padding-left:.75em}
table.linenotable td.linenos{border-right:1px solid currentColor;opacity:.35;padding-right:.5em}
pre.pygments .lineno{border-right:1px solid currentColor;opacity:.35;display:inline-block;margin-right:.75em}
pre.pygments .lineno::before{content:"";margin-right:-.125em}
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
.quoteblock blockquote{margin:0;padding:0;border:0}
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
.verseblock{margin:0 1em 1.25em}
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
.verseblock pre strong{font-weight:400}
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
.quoteblock .attribution br,.verseblock .attribution br{display:none}
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;text-align:left;margin-right:0}
table.tableblock{max-width:100%;border-collapse:separate}
p.tableblock:last-child{margin-bottom:0}
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
td.tableblock>.content>:last-child.sidebarblock{margin-bottom:0}
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px}
table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0}
table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
table.frame-all{border-width:1px}
table.frame-sides{border-width:0 1px}
table.frame-topbot,table.frame-ends{border-width:1px 0}
table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd),table.stripes-even tr:nth-of-type(even),table.stripes-hover tr:hover{background:#f8f8f7}
th.halign-left,td.halign-left{text-align:left}
th.halign-right,td.halign-right{text-align:right}
th.halign-center,td.halign-center{text-align:center}
th.valign-top,td.valign-top{vertical-align:top}
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
th.valign-middle,td.valign-middle{vertical-align:middle}
table thead th,table tfoot th{font-weight:bold}
tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
p.tableblock>code:only-child{background:none;padding:0}
p.tableblock{font-size:1em}
ol{margin-left:1.75em}
ul li ol{margin-left:1.5em}
dl dd{margin-left:1.125em}
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
ul.unstyled,ol.unstyled{margin-left:0}
ul.checklist{margin-left:.625em}
ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
ul.inline>li{margin-left:1.25em}
.unstyled dl dt{font-weight:400;font-style:normal}
ol.arabic{list-style-type:decimal}
ol.decimal{list-style-type:decimal-leading-zero}
ol.loweralpha{list-style-type:lower-alpha}
ol.upperalpha{list-style-type:upper-alpha}
ol.lowerroman{list-style-type:lower-roman}
ol.upperroman{list-style-type:upper-roman}
ol.lowergreek{list-style-type:lower-greek}
.hdlist>table,.colist>table{border:0;background:none}
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
.colist td:not([class]):first-child img{max-width:none}
.colist td:not([class]):last-child{padding:.25em 0}
.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
.imageblock.left{margin:.25em .625em 1.25em 0}
.imageblock.right{margin:.25em 0 1.25em .625em}
.imageblock>.title{margin-bottom:0}
.imageblock.thumb,.imageblock.th{border-width:6px}
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
.image.left{margin-right:.625em}
.image.right{margin-left:.625em}
a.image{text-decoration:none;display:inline-block}
a.image object{pointer-events:none}
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
sup.footnote a,sup.footnoteref a{text-decoration:none}
sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
#footnotes .footnote:last-of-type{margin-bottom:0}
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
.gist .file-data>table td.line-data{width:99%}
div.unbreakable{page-break-inside:avoid}
.big{font-size:larger}
.small{font-size:smaller}
.underline{text-decoration:underline}
.overline{text-decoration:overline}
.line-through{text-decoration:line-through}
.aqua{color:#00bfbf}
.aqua-background{background:#00fafa}
.black{color:#000}
.black-background{background:#000}
.blue{color:#0000bf}
.blue-background{background:#0000fa}
.fuchsia{color:#bf00bf}
.fuchsia-background{background:#fa00fa}
.gray{color:#606060}
.gray-background{background:#7d7d7d}
.green{color:#006000}
.green-background{background:#007d00}
.lime{color:#00bf00}
.lime-background{background:#00fa00}
.maroon{color:#600000}
.maroon-background{background:#7d0000}
.navy{color:#000060}
.navy-background{background:#00007d}
.olive{color:#606000}
.olive-background{background:#7d7d00}
.purple{color:#600060}
.purple-background{background:#7d007d}
.red{color:#bf0000}
.red-background{background:#fa0000}
.silver{color:#909090}
.silver-background{background:#bcbcbc}
.teal{color:#006060}
.teal-background{background:#007d7d}
.white{color:#bfbfbf}
.white-background{background:#fafafa}
.yellow{color:#bfbf00}
.yellow-background{background:#fafa00}
span.icon>.fa{cursor:default}
a span.icon>.fa{cursor:inherit}
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
.conum[data-value] *{color:#fff!important}
.conum[data-value]+b{display:none}
.conum[data-value]::after{content:attr(data-value)}
pre .conum[data-value]{position:relative;top:-.125em}
b.conum *{color:inherit!important}
.conum:not([data-value]):empty{display:none}
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
p{margin-bottom:1.25rem}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
.print-only{display:none!important}
@page{margin:1.25cm .75cm}
@media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
html{font-size:80%}
a{color:inherit!important;text-decoration:underline!important}
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
abbr[title]::after{content:" (" attr(title) ")"}
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
thead{display:table-header-group}
svg{max-width:100%}
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
body.book #header{text-align:center}
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
body.book #header .details{border:0!important;display:block;padding:0!important}
body.book #header .details span:first-child{margin-left:0!important}
body.book #header .details br{display:block}
body.book #header .details br+span::before{content:none!important}
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
.listingblock code[data-lang]::before{display:block}
#footer{padding:0 .9375em}
.hide-on-print{display:none!important}
.print-only{display:block!important}
.hide-for-print{display:none!important}
.show-for-print{display:inherit!important}}
@media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem}
.sect1{padding:0!important}
.sect1+.sect1{border:0}
#footer{background:none}
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
</style>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
</head>
<body class="article toc2 toc-left">
<div id="header">
<h1>什么是 AsciiDoc? 我们为什么需要它?</h1>
<div class="details">
<span id="author" class="author">Dan Allen</span><br>
<span id="email" class="email"><a href="https://github.com/mojavelinux">@mojavelinux</a></span><br>
<span id="revnumber">version 2.0,</span>
<span id="revdate">2014-08-09</span>
</div>
<div id="toc" class="toc2">
<div id="toctitle">目录</div>
<ul class="sectlevel1">
<li><a href="#什么是-asciidoc">什么是 AsciiDoc?</a></li>
<li><a href="#为什么选择-asciidoc">为什么选择 AsciiDoc?</a>
<ul class="sectlevel2">
<li><a href="#论写作对比邮件和文档">论写作：对比邮件和文档</a></li>
<li><a href="#文字处理器作家真正的障碍">文字处理器：作家真正的障碍</a></li>
<li><a href="#使用你懂的">使用你懂的</a></li>
</ul>
</li>
<li><a href="#谁在使用-asciidoc">谁在使用 AsciiDoc?</a></li>
<li><a href="#编写-asciidoc-的禅意">编写 AsciiDoc 的禅意</a></li>
<li><a href="#下一步">下一步</a></li>
</ul>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>“<em>写文档太难了</em>。”</p>
</div>
<div class="paragraph">
<p>这就是我们得出的经验。</p>
</div>
<div class="paragraph">
<p>但是我们还不能避免它，尤其是在科技行业。
我们 <em>必须</em> 写文档。
没有完善的文档，即使是最出色的软件也毫无用处。
如果用户不会使用你的软件，那整个项目就都失败了。</p>
</div>
<div class="quoteblock">
<blockquote>
除非用户界面的引导性做的 <strong>近乎完美</strong>，否则的话 “这个功能没有文档“ 就相当于 “我们的产品没有实现这个功能“。
</blockquote>
<div class="attribution">
&#8212; Nick Coghlan
</div>
</div>
<div class="paragraph">
<p>换句话说,</p>
</div>
<div class="quoteblock">
<blockquote>
是生是死全看文档。
</blockquote>
<div class="attribution">
&#8212; Matthew Ginnard
</div>
</div>
<div class="paragraph">
<p>那么为什么，<em>究竟是为什么</em> 我们要如此辛苦地把内容藏到类似DocBook之类的xml之下，让复杂的文字处理分散我们的注意力，或者把时间浪费在过分注重所见即所得（WYSIWYG）的编辑器上面呢？</p>
</div>
<div class="paragraph">
<p>想象一下，如果写文档就像写邮件一样简单。</p>
</div>
<div class="paragraph">
<p><em>它 <strong>可以</strong> 是这样的</em>。</p>
</div>
<div class="paragraph">
<p>这就是轻量级标记语言 AsciiDoc 背后的思想。
它提供了一种纯文本语法，用微妙但直观的标记加以修饰，这是为人类设计的，以一种原始的形式进行读、写以及编辑而设计的。
这种语法会自然而然地让你更专注于内容。
最重要的是，纯文本可以快速简单地转换成其它输出格式，比如HTML5。</p>
</div>
<div class="paragraph">
<p>在这篇对 AsciiDoc 的介绍中，我们将介绍它是什么、它为什么有价值，以及它与其他替代品（如Markdown）的区别。
您会发现，摆脱编写文档的痛苦的关键是去掉尖括号(&lt;div&gt;xxx&lt;/div&gt;)，因为它们遮住了您分享的知识。</p>
</div>
<div class="paragraph">
<p>要想学习如何减少写作以及发布的工作量（无论是笔记、文档、文章、书记、网页或者是老是散文），追求写作的禅意，或者是将想法记录在脑海中，那么请继续往下看。</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="什么是-asciidoc">什么是 AsciiDoc?</h2>
<div class="sectionbody">
<div class="paragraph">
<p>AsciiDoc 做到了两件事:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>一种成熟的<sup class="footnote">[<a id="_footnoteref_1" class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup>，纯文本写作格式，用于创作笔记、文章、文档、书籍、电子书、网页、幻灯片、博客文章、手册页等。</p>
</li>
<li>
<p>一个文本处理器以及工具链，用于将 AsciiDoc 文档转换为各种格式（称为 <em>后端</em> ），包括HTML、DocBook、PDF和ePub<sup class="footnote">[<a id="_footnoteref_2" class="footnote" href="#_footnotedef_2" title="View footnote.">2</a>]</sup>。</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>AsciiDoc 属于 <a href="https://en.wikipedia.org/wiki/Lightweight_markup_language">轻量级标记语言</a> 家族，其中最著名的是 <a href="https://daringfireball.net/projects/markdown/">Markdown</a>。
AsciiDoc 从这个小组中脱颖而出，因为它支持起草文章、技术手册、书籍、演示文稿和散文所需的所有结构元素。
事实上，它甚至能够满足最高级的发布需求和技术语义。</p>
</div>
<div class="paragraph">
<p>作为这一事实的证明，许多 O&#8217;Reilly 的作者，包括 <a href="https://github.com/matthewmccullough">Matthew McCullough</a>， <a href="https://github.com/tlberglund">Tim Berglund</a>， <a href="https://github.com/oreillymedia/etudes-for-erlang">Simon St.Laurent</a>， <a href="https://www.apeth.net/matt/iosbooktoolchain.html">Matt Neuburg</a> 和 <a href="https://www.oreilly.com/pub/au/219">Ian Darwin</a> 已经用 AsciiDoc 这个技术编写他们的书。</p>
</div>
<div class="paragraph">
<p>从一开始， AsciiDoc 就被设计成 <a href="https://docbook.org/whatis">DocBook</a> 的速记替代品，DocBook也是是  <a href="https://docbook.org/whatis">DocBook</a> 可以生成的格式之一。
AsciiDoc 还可以制作漂亮的HTML5、PDF、电子书、手册页甚至幻灯片。
它涵盖了从初稿到出版的全过程。</p>
</div>
<div class="paragraph">
<p>既然我们已经确定了 AsciiDoc 是什么，接下来让我们考虑一下为什么我们需要它。</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="为什么选择-asciidoc">为什么选择 AsciiDoc?</h2>
<div class="sectionbody">
<div class="paragraph">
<p>作为人类，说话和思考没什么难的。
这是一种只要有想法就会自然发生的活动。</p>
</div>
<div class="paragraph">
<p><em>但是，写作却不那么容易。</em></p>
</div>
<div class="paragraph">
<p>当我们想把想法写下来的时候，我们就 <em>很难</em> 找到什么词语&#8212;&#8203;或者是如何安排以及组织它们。
那个 <em>操蛋的</em> 内心扰乱了我们说话以及思考。</p>
</div>
<div class="paragraph">
<p>于是我们有理由得出这样的结论：写作很难。</p>
</div>
<div class="paragraph">
<p><em>但这是真的吗?</em></p>
</div>
<div class="sect2">
<h3 id="论写作对比邮件和文档">论写作：对比邮件和文档</h3>
<div class="paragraph">
<p>写邮件很简单。
我们经常写邮件。
每天我们都会回复几十封邮件和社交信息。
这其中我们都通过写作进行交流。
没错，就是 <em>写作</em> ！</p>
</div>
<div class="paragraph">
<p>然而，当我们回复电子邮件时，我们几乎没有意识到自己在打字&#8230;&#8203;而且很 <em>流利</em> ！</p>
</div>
<div class="paragraph">
<p>事实证明&#8230;&#8203;</p>
</div>
<div class="quoteblock">
<blockquote>
大多数人都能写电子邮件。
他们不认为这是写作。
因为这其中没有身为作家的心里障碍。
有人问你一个问题，你会自然的 [按] 键打字回复。
</blockquote>
<div class="attribution">
&#8212; <a href="https://blog.stoyanstefanov.com/asciidoc">Stoyan Stefanov</a>
</div>
</div>
<div class="paragraph">
<p><em>但是为什么我们写 <strong>文档</strong> 却如此困难呢？</em></p>
</div>
<div class="paragraph">
<p>这其中困难的主要原因是写文档和发邮件的方式不同。
和邮件不同的是，我们将大量的精力和注意力放在复杂的文字处理程序以及DocBook之类的XML结构上，或者是与挑剔的（WYSIWYG）编辑器战斗了。
怎么会陷入这样的困境呢？</p>
</div>
</div>
<div class="sect2">
<h3 id="文字处理器作家真正的障碍">文字处理器：作家真正的障碍</h3>
<div class="paragraph">
<p>当你处于写作（即 <a href="https://blog.stoyanstefanov.com/writing-vs-typing/">打字</a> ）阶段时，你希望文字在屏幕上流动，同时尽量减少干扰和干扰。
是文字流动，不仅是时间流动，这一点是必不可少的。</p>
</div>
<div class="paragraph">
<p>大多数文字处理器擅长分散你的写作注意力。结果是： <em>你写的更少了</em>（很讽刺吧？）。</p>
</div>
<div class="paragraph">
<p>在文字处理器中，当你在空白屏幕上输入第一个字之前，你必须考虑你想要什么字体，字体要用什么大小，以及行间距等等。
一旦你开始写作了，自动更正、拼写以及语法建议又会让你忘记下一个想法。
“智能” 引号和自动链接的文字，以最快的速度输入它。
如果你从别的地方复制了一段文本，则可能会把不同的字体、大小甚至颜色都一起粘贴到文档里面来。</p>
</div>
<div class="paragraph">
<p><strong>撤销。撤销。撤销！</strong></p>
</div>
<div class="paragraph">
<p>我们甚至不讨论插入源代码。
文字处理器的设计者显然没有考虑过这玩意。</p>
</div>
<div class="paragraph">
<p><strong>格式化。格式化。格式化！</strong></p>
</div>
<div class="paragraph">
<p>在与文字处理器进行了一番激烈斗争之后，你有理由确定就是它在试图 <em>破坏</em> 你整个写作的过程。</p>
</div>
<div class="paragraph">
<p><strong>我们 <em>需要</em> 一个更简单的方式来写作！</strong></p>
</div>
<div class="paragraph">
<p>但现在呢？</p>
</div>
</div>
<div class="sect2">
<h3 id="使用你懂的">使用你懂的</h3>
<div class="paragraph">
<p><em>如果你可以像写邮件一样写文档呢？</em></p>
</div>
<div class="paragraph">
<p>想象一下，忘记布局、排版、样式（甚至一些语义），而仅仅是 <em>写作</em>。
这就是 Markdown 或 AsciiDoc 等 <strong>轻量级标记语言</strong> 背后的思想。</p>
</div>
<div class="paragraph">
<p>这是 John Gruber 在 2004 年 3 月介绍 Markdown 的一段话：</p>
</div>
<div class="quoteblock">
<blockquote>
<div class="paragraph">
<p>Markdown语法的首要设计目标就是使其尽可能的易读。</p>
</div>
<div class="paragraph">
<p>Markdown格式的文档可以原样出版，就像纯文本一样，而不是看起来像是用标记或格式化说明标记的。</p>
</div>
<div class="paragraph">
<p>Markdown语法的一个最大的灵感来源是纯文本电子邮件的格式。</p>
</div>
</blockquote>
<div class="attribution">
&#8212; John Gruber, Markdown 的作者
</div>
</div>
<div class="paragraph">
<p>同样，以下是 Stuart Rackham 在 2 年前介绍 AsciiDoc 的一段话：</p>
</div>
<div class="quoteblock">
<blockquote>
您可以使用和普通文本文档相同的方式编写 AsciiDoc 文档。
这里没有标签或是什么奇怪格式的标记。
AsciiDoc 文件被设计成可以直接查看、编辑、打印或者是翻译成其他表现格式。
</blockquote>
<div class="attribution">
&#8212; Stuart Rackham, AsciiDoc 的作者
</div>
</div>
<div class="paragraph">
<p>这些语言的设计目的是让人类编写文档，并让其他人能够 <em>以</em> <em>原始</em> 地形式阅读文档。</p>
</div>
<div class="paragraph">
<p>下面是一个 AsciiDoc 的简单示例：</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code data-lang="asciidoc">= Introduction to AsciiDoc
Doc Writer &lt;doc@example.com&gt;

A preface about https://asciidoc.org[AsciiDoc].

== First Section

* item 1
* item 2

[source,ruby]
puts "Hello, World!"</code></pre>
</div>
</div>
<div class="paragraph">
<p><em>它是纯文本语法的&#8230;&#8203;我 <strong>知道</strong> ！</em></p>
</div>
<div class="paragraph">
<p>将其与DocBook编写的相同文档进行比较：</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code data-lang="xml">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
    "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"&gt;
&lt;article lang="en"&gt;
  &lt;articleinfo&gt;
    &lt;title&gt;Introduction to AsciiDoc&lt;/title&gt;
    &lt;date&gt;2013-01-01&lt;/date&gt;
    &lt;author&gt;
      &lt;firstname&gt;Doc&lt;/firstname&gt;
      &lt;surname&gt;Writer&lt;/surname&gt;
      &lt;email&gt;doc@example.com&lt;/email&gt;
    &lt;/author&gt;
    &lt;authorinitials&gt;DW&lt;/authorinitials&gt;
  &lt;/articleinfo&gt;
  &lt;simpara&gt;
    A preface about
    &lt;ulink url="http://asciidoc.org"&gt;AsciiDoc&lt;/ulink&gt;.
  &lt;/simpara&gt;
  &lt;section id="_first_section"&gt;
    &lt;title&gt;First Section&lt;/title&gt;
    &lt;itemizedlist&gt;
      &lt;listitem&gt;
        &lt;simpara&gt;item 1&lt;/simpara&gt;
      &lt;/listitem&gt;
      &lt;listitem&gt;
        &lt;simpara&gt;item 2&lt;/simpara&gt;
      &lt;/listitem&gt;
    &lt;/itemizedlist&gt;
    &lt;programlisting language="ruby"
        linenumbering="unnumbered"&gt;
      &lt;![CDATA[puts "Hello, World!"]]&gt;
    &lt;/programlisting&gt;
  &lt;/section&gt;
&lt;/article&gt;</code></pre>
</div>
</div>
<div class="paragraph">
<p>哎我去!</p>
</div>
<div class="paragraph">
<p>虽然DocBook（和HTML）可能并不复杂，但它们无法通过可读性测试。</p>
</div>
<div class="quoteblock">
<blockquote>
DocBook很好，但是（像XML一样）它不能用于编辑或合并更改（通过人工）。
使用 AsciiDoc（可以完美地翻译为DocBook）是一种更简单的开发方式。
</blockquote>
<div class="attribution">
&#8212; Dag Wieers
</div>
</div>
<div class="paragraph">
<p>AsciiDoc 让我们回到了最重要的部分： <em>写作</em> 。
你可以去掉那些尖括号，但不必去掉语义。
这是一种方便人类有效编辑的语法。</p>
</div>
<div class="quoteblock">
<blockquote>
使用 AsciiDoc 写文档。
是真正意义上更方便人类，提高 <strong>可读</strong> 性，且比XML更容易解析，更灵活。
</blockquote>
<div class="attribution">
&#8212; Linus Torvalds
</div>
</div>
<div class="paragraph">
<p>这是关于 AsciiDoc 的最棒的东西。
更糟糕的情况是，将其转换为 DocBook 作为通用交换格式。
DocBook 是 AsciiDoc 的“无锁定”退出路径。
如果你发现 AsciiDoc 不起作用，你可以毫不犹豫地放弃它。
不需要发明另一种格式。
这就是为什么这么多人都用它的原因。</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="谁在使用-asciidoc">谁在使用 AsciiDoc?</h2>
<div class="sectionbody">
<div class="paragraph">
<p>AsciiDoc 并不像 Markdown 那样被广泛采用，但它也在一些重要的的地方使用。
以下是几个重要的例子：</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="http://oreillynet.com/oreilly/authors/welcome/asciidoc.csp">O&#8217;Reilly</a> 和 <a href="https://github.com/MakerPress">MakerPress</a></p>
<div class="ulist">
<ul>
<li>
<p><a href="http://clojure-cookbook.com">Clojure Cookbook</a> (<a href="https://github.com/clojure-cookbook/clojure-cookbook">AsciiDoc 源码</a>)</p>
</li>
</ul>
</div>
</li>
<li>
<p><a href="https://github.com">GitHub</a> 在 repositories, wikis 以及 gists 方面支持 AsciiDoc 语法 (由 <a href="https://asciidoctor.org">Asciidoctor</a> 提供支持)</p>
</li>
<li>
<p><a href="https://nofluffjuststuff.com/home/magazine_subscribe">NFJS, the Magazine</a> 就是使用 AsciiDoc 制作的文章</p>
</li>
<li>
<p>Java EE 平台下上下文以及依赖注入 (CDI)</p>
<div class="ulist">
<ul>
<li>
<p><a href="https://docs.jboss.org/cdi/spec/2.0/cdi-spec.html">文档</a> (<a href="https://github.com/cdi-spec/cdi/tree/master/spec">AsciiDoc 源码</a>)</p>
</li>
<li>
<p><a href="http://www.cdi-spec.org">官方网站</a> (<a href="https://github.com/cdi-spec/cdi-spec.org">AsciiDoc 源码</a>)</p>
</li>
</ul>
</div>
</li>
<li>
<p><a href="https://golo-lang.org/documentation/next">Golo 语言编程指南</a> (<a href="https://github.com/golo-lang/golo-lang/tree/master/doc">AsciiDoc 源码</a>)</p>
</li>
<li>
<p><a href="https://docs.neo4j.org/chunked/stable">Neo4j 图形数据库项目</a> (<a href="https://github.com/neo4j/neo4j-documentation">AsciiDoc 源码</a>)</p>
</li>
<li>
<p><a href="http://www.modrails.com/documentation/Users%20guide%20Apache.html">Phusion Passenger 用户指南</a> (<a href="https://github.com/FooBarWidget/passenger/tree/master/doc">AsciiDoc 源码</a>)</p>
</li>
<li>
<p><a href="https://www.kernel.org/pub/software/scm/git/docs/user-manual.html">Git 用户指南</a> (<a href="https://github.com/git/git/tree/master/Documentation">AsciiDoc 源码</a>)</p>
</li>
<li>
<p><a href="http://enterprisewebbook.com">Enterprise Web Development: From Desktop to Mobile</a> (<a href="https://github.com/Farata/EnterpriseWebBook">AsciiDoc 源码</a>)</p>
</li>
<li>
<p>Bintray <a href="https://bintray.com/docs/api/">REST API</a> 以及 <a href="https://bintray.com/docs/usermanual/">用户手册</a></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>这些例子不仅是证明。
同时也是给你一些灵感，告诉你如何在自己的项目中使用 AsciiDoc。</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="编写-asciidoc-的禅意">编写 AsciiDoc 的禅意</h2>
<div class="sectionbody">
<div class="paragraph">
<p>AsciiDoc 注重表达你的想法、轻松地写作和传递知识，而不受复杂应用程序或尖括号的干扰。
换句话说，这就是 <em>写作的禅意</em> 。</p>
</div>
<div class="paragraph">
<p>AsciiDoc 的关注点是让你表达自己的想法，轻松地写作和传递知识</p>
</div>
<div class="paragraph">
<p>AsciiDoc 之所以好用，是因为:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>可读性`</p>
</li>
<li>
<p>简洁</p>
</li>
<li>
<p>全面</p>
</li>
<li>
<p>可拓展</p>
</li>
<li>
<p>漂亮的输出 (HTML, DocBook, PDF, ePub 等)</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>AsciiDoc 易于编写和阅读（原始形式）。
它也很容易校对和编辑。
毕竟，它是纯文本，就像我们熟悉的电子邮件。</p>
</div>
<div class="paragraph">
<p>AsciiDoc 语法是直观的，因为它经历了时间的考验，并以纯文本的形式标记以及结构化文本。
就连标点符号都是精心挑选的，让人一看就明白它的意思。
不熟悉 AsciiDoc 的用户可以看一眼就大概明白它的结构和语义。
最棒的是，<strong>可以使用任意一个文本编辑器来读写</strong>。</p>
</div>
<div class="paragraph">
<p>AsciiDoc 可以让您的注意力集中在实际的编写上，只需在准备转换文档时考虑一下如何输出。
AsciiDoc 文档的纯文本可以轻松地转换为各种输出格式，格式优美，无需重写内容。</p>
</div>
<div class="paragraph">
<p>将电子邮件中的文本复制到文档中，然后查看将其转换为文档的速度。
几乎立刻，你会发现写作的禅意，享受分享知识的乐趣。</p>
</div>
<div class="paragraph">
<p>是生是死全看文档?<br>
“当然是生!”</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="下一步">下一步</h2>
<div class="sectionbody">
<div class="paragraph">
<p>了解了什么是 AsciiDoc 以及为什么如此迫切地需要它，我们建议您在 <a href="asciidoc-writers-guide.html">AsciiDoc 编写指南</a> 中再深入研究一下。
如果你只是在找一份备忘录，请查看 <a href="asciidoc-syntax-quick-reference.html">AsciiDoc 参考指南</a>。
希望你会觉得这些语法还是很合理的。</p>
</div>
</div>
</div>
</div>
<div id="footnotes">
<hr>
<div class="footnote" id="_footnotedef_1">
<a href="#_footnoteref_1">1</a>. AsciiDoc 已经有十多年历史了。他在2002年被首次发明。
</div>
<div class="footnote" id="_footnotedef_2">
<a href="#_footnoteref_2">2</a>. AsciiDoc 处理器有两个实现。最初的处理器名叫 AsciiDoc，是用Python编写的。另一个更现代的实现，名叫 Asciidoctor，是用Ruby编写的。
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/run_prettify.min.js"></script>
</body>
</html>